home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / rem_acc / tstat047.zip / TOPSTAT.DOC < prev    next >
Text File  |  1996-05-28  |  19KB  |  437 lines
  1.  
  2.        ┌─
  3.        │  ┌───────┐┌──────┐┌──────┐┌──────┐┌───────┐┌──────┐┌───────┐
  4.        │  └───────┘└──────┘└──────┘└──────┘└───────┘└──────┘└───────┘
  5.        │     ┌─┐   ┌─┐  ┌─┐┌──────┐┌──────┐   ┌─┐   ┌──────┐   ┌─┐
  6.        │     │ │   │ │  │ ││ ┌────┘└────┐ │   │ │   │ ┌──┐ │   │ │
  7.        │     │ │   │ └──┘ ││ │     ┌────┘ │   │ │   │ │  │ │   │ │
  8.        │     └─┘   └──────┘└─┘     └──────┘   └─┘   └─┘  └─┘   └─┘
  9.        └──────────────────────────────────────────────────────── v0.47 ─
  10.  
  11.                            A BBS Statistics Generator
  12.                     Copyright (c) 1994-1996, Dwayne Heaton
  13.  
  14.              ┌─
  15.              │                       Index
  16.              └───────────────────────────────────────────────────
  17.  
  18.                                  Introduction
  19.  
  20.              What is TopStat? ............................... 1.1
  21.              System Hardware & software requirements ........ 1.2
  22.              Disclaimer and Licensing agreement ............. 1.3
  23.  
  24.              Installation ................................... 2.0
  25.  
  26.                                      Usage
  27.  
  28.              Command Line ................................... 3.1
  29.              The TOPSTAT.CTL file ........................... 3.2
  30.              The TOPSTAT.EXC file ........................... 3.3
  31.              The TOPSTAT.SEC file ........................... 3.4
  32.  
  33.              Bug Reports and Contacting the Author .......... 4.0
  34.  
  35.              Credits and Thanks ............................. 5.0
  36.  
  37.  
  38.  
  39.  
  40. ┌─
  41. │  1.1  What is TopStat
  42. └──────────────────────────────────────────────────────────────────────────────
  43.  
  44.    TopStat is a RemoteAccess BBS Statistics generator. It currently produces
  45.    a total of fifteen bulletins, ranging from top downloaders to upcoming
  46.    user birthdays to message base statistics. It will produce ASCII, ANSi and
  47.    AVATAR bulletins.
  48.  
  49.    TopStat was originally written just to display a few screens of the top
  50.    uploaders, downloaders and callers to my BBS. It has expanded a little
  51.    since then, due to requests for extra bulletins to be generated.
  52.  
  53.    TopStat is designed to produce the bulletins as quickly as is possible with
  54.    as little configuring by the sysop, while also allowing it to be flexable.
  55.    I hope this has been achieved.
  56.  
  57.  
  58.    TopStat is not crippled in any way what-so-ever, and it does not require
  59.    any registration fees to be send in to use it.
  60.  
  61.  
  62. ┌─
  63. │  1.2  System Hardware and Software Requirements
  64. └──────────────────────────────────────────────────────────────────────────────
  65.  
  66.  ■ An IBM PC, XT, AT or 100% compatible PC with a hard disk.
  67.  ■ Microsoft MS-DOS, IBM PC-DOS or DR-DOS version 3.30 or later. Version
  68.    5.0 or later is recommended.
  69.  ■ At least 128KB of RAM available.
  70.  
  71.  ■ At the moment TopStat only supports the following BBS user database:
  72.      ■ Remote Access    Copyright (c) Wantree Development & Andrew Milner
  73.  
  74.  ■ At The moment TopStat only supports the following Message databases:
  75.      ■ Hudson     Copyright (c) Adam Hudson
  76.      ■ JAM(mbp)   Copyright (c) Joaquim Homrighausen, Andrew Milner,
  77.                                 Mats Birch, Mats Wallin.
  78.  
  79.  ■ TopStat has been successfully tested with MS-DOS 5.0, 6.0, 6.2 and 6.22,
  80.    4DOS 5.0 and 5.5, IBM OS/2 WARP, Windows 3.1, Windows for Workgroups 3.11
  81.    and Windows 95, Novell Netware Lite v1.1, Novell Netware v3.12 on systems
  82.    equiped with Intel/AMD 8086, 80286, 80386, 80486 and Pentium(tm) processors.
  83.  
  84.  ■ TopStat has been successfully tested with the user base as used in
  85.    RemoteAccess v2.00, v2.01, v2.02 and v2.50.
  86.  
  87.  ■ OS/2 is a registered trademark of IBM Corporation
  88.    MS-DOS and Windows are a registered trademarks of Microsoft Corporation
  89.  
  90.    All other programs are copyright and/or trademarked by their respective
  91.    author(s) unless otherwise noted.
  92.  
  93.  
  94. ┌─
  95. │  1.3  Disclaimer and Licensing Agreement
  96. └──────────────────────────────────────────────────────────────────────────────
  97.  
  98.    TOPSTAT consists of all files contained within the distribution archive.
  99.    Before running TOPSTAT, you must read and agree to the following conditions.
  100.    If you do not or can not agree to and accept the following conditions, you
  101.    are prohibited from using TOPSTAT.
  102.  
  103.  ■ The documentation and accompanying program are copyrighted material 
  104.    designed, produced and tested by the author of the software.
  105.  
  106.  ■ TOPSTAT is distributed as FREEWARE *NOT* Public Domain!
  107.  
  108.  ■ Since this product is FREEWARE, you are actively encouraged to copy and
  109.    distribute it as long as it remains in its complete form with all support
  110.    and documentation files. No files may be added or taken away from the
  111.    original archived form in which TOPSTAT is distributed.
  112.  
  113.  ■ Shareware vendors and BBSes may redistribute this product as long as they
  114.    do not charge any money or monies for the product. Cost of distribution
  115.    media (be it disk, CD-ROM, tape, etc) and/or subscription charges are
  116.    acceptable.
  117.  
  118.  ■ I (Dwayne Heaton) am NOT oligated to provide new versions or support for
  119.    TOPSTAT.
  120.  
  121.  ■ In the event that future versions of TOPSTAT are released, Dwayne Heaton
  122.    reserves the right not to release them under the FREEWARE concept and to
  123.    charge a nominal fee should it be deemed appropriate.
  124.  
  125.  ■ Although every care and attention has been taken to write and test the
  126.    program to make sure that it does what this documentation states, the
  127.    program is provided as it is, without warranty or guarantee of any kind,
  128.    either expressed or implied, as to the quality or performance of this
  129.    program, except that it will occupy disk space.
  130.  
  131.  ■ The author shall not be held liable to you or anyone else for any direct,
  132.    indirect, incidental or consequential damages, including any lost profits,
  133.    lost savings, lost business, which may result from the use or inability
  134.    to use this program.
  135.  
  136.  ■ You are NOT allowed to do any disassembling, reverse engineering, creating
  137.    patches for TOPSTAT and things alike.
  138.  
  139.  ■ Your use of this program constitutes your agreement to this disclaimer and
  140.    your release of the author from any form of liability or litigation.
  141.  
  142.  ■ The source code or part of it, is NOT available.
  143.  
  144.  ■ All rights reserved worldwide.
  145.  
  146.  
  147. ┌─
  148. │  2.0  Installation
  149. └──────────────────────────────────────────────────────────────────────────────
  150.  
  151.    Making use of TopStat couldn't be much easier! Unpack all the files in the
  152.    archive into one directory (guess you might be at the point already). This
  153.    directory is your TopStat system directory.
  154.  
  155.    TopStat is fully configurable, and a menu driven setup program is included
  156.    to allow you to create an config file for your system. The control file is
  157.    an ascii text file, and can be edited using any text editor if you do not
  158.    wish to use the setup program. (The options in the control file are covered
  159.    in section 3.2, 'The TOPSTAT.CTL file' later in this document')
  160.  
  161.    TopStat will also allow you to exclude specific users from the bulletins.
  162.    The file to allow this is explained in more detail in section 3.3, 'The
  163.    TOPSTAT.EXC file'
  164.  
  165.    You will need to have the RA environment variable set, so that it points
  166.    to your RemoteAccess system directory, but if you are running RA without
  167.    any problems, this should be already be set  :)
  168.  
  169.    Once you have installed TopStat and configured it, you are ready to produce
  170.    your first bulletins. The bulletins will be placed in the main Text Files
  171.    directory as specified in your RemoteAccess configuration file. I've done
  172.    it this way so that on a multi-language system all languages can display
  173.    the bulletins without having to copy/move them to each of the language's
  174.    text files directory.
  175.  
  176.    You can run TopStat after every call to the BBS, or in a nightly maintenance
  177.    event.
  178.  
  179.    Please Note: TopStat will try and use share to open all the files it needs.
  180.                 This will allow multi-node BBS's to run it without having to
  181.                 take all the nodes down first.
  182.  
  183. ┌─
  184. │  3.1  Command Line
  185. └──────────────────────────────────────────────────────────────────────────────
  186.  
  187.    TopStat no longer supports command line options. All configuration is now
  188.    done via the control file.
  189.  
  190.  
  191. ┌─
  192. │  3.2  The TOPSTAT.CTL file
  193. └──────────────────────────────────────────────────────────────────────────────
  194.  
  195.    As mentioned before, the configuration file will allow you to fully
  196.    configure TopStat to your system.
  197.  
  198.    The best way to create an initial configuration file is to run the setup
  199.    program, which will attempt to auto-detect some of the options for your
  200.    system (mainly which version of RemoteAccess you are using).
  201.  
  202.    If you are upgrading from a previous TopStat installation, run the setup
  203.    program and save the configuration. This will produce an updated config
  204.    file. (This is not really necessary since TopStat can use any old config
  205.    options)
  206.  
  207.    Please remember to save the control file before you exit the setup program.
  208.  
  209.  
  210.    The options in the configuration file can be in any order, and any line
  211.    starting with a ';' (no quotes) is considered to be a comment line and
  212.    is not processed.
  213.  
  214.    Here is a list of options you can use, and a short description of what they
  215.    do.
  216.  
  217.  
  218.    General Settings
  219.    ----------------
  220.    BBSSoftware        The version of RemoteAccess you are running.
  221.    IncludeSysop       Whether to include the Sysop in the output, or not.
  222.                       (Even if he/she is a hidden user)
  223.    IncludeHidden      Include users marked as HIDDEN in the output.
  224.    IncludeGuest       Include GUEST users in the output.
  225.    UseHandles         Use user-handles instead of their real names.
  226.    ASCII              Produce ASCII output bulletins.
  227.    ANSi               Produce ANSi output bulletins.
  228.    AVATAR             Produce AVATAR output bulletins.
  229.    EnterPrompt        Add the RemoteAccess 'Wait for Enter' control code.
  230.    BirthdayCount      The number of days to include for Upcoming Birthdays
  231.  
  232.    BBSSoftware accepts the following values : RA20x, RA250
  233.  
  234.    IncludeSysop, IncludeHidden, UseHandles, ASCII, ANSi, AVATAR and
  235.    EnterPrompt accept the following values : Yes or No, On or Off, True
  236.                                              or False
  237.  
  238.    BirthdayCount accepts an integer in the range 1 to 366.
  239.  
  240.    Colour Settings
  241.    ---------------
  242.    Main.Title           The colour of the Bulletin Title (used in all the
  243.                         available bulletins)
  244.    Main.Border          The colour of the border (used in all the available
  245.                         bulletins)
  246.    General.Name         The colour of the Username (or handle) , as used in
  247.                         the non-graph bulletins.
  248.    General.Value        The colour of the value (Files, KB, etc) as used in
  249.                         the non-graph bulletins.
  250.    Graph.Desc           The colour of the description of the range (only
  251.                         used in the graph bulletins)
  252.    Graph.Count          The colour of the count in the graph bulletins
  253.    Graph.Bar            The colour of the Bar in the graph bulletins
  254.    Graph.Percent        The colour of the percentage
  255.    BDay.Name            The colour of the username in the birthdays bulletin
  256.    BDay.Age             The colour of the age in the birthdays bulletin
  257.    BDay.DOB             The colour of the birthdate in the birthdays bulletin
  258.  
  259.    ╓─────────────────── Table of valid names and numbers ────────────────────╖
  260.    ╠════╤══════════╗╔════╤══════════════╗╔════╤════════════╗╔════╤═══════════╣
  261.    ║  0 │ Black    ║║  1 │ Blue         ║║  2 │ Green      ║║  3 │ Cyan      ║
  262.    ║  4 │ Red      ║║  5 │ Magenta      ║║  6 │ Brown      ║║  7 │ LightGray ║
  263.    ║  8 │ DarkGray ║║  9 │ LightBlue    ║║ 10 │ LightGreen ║║ 11 │ LightCyan ║
  264.    ║ 12 │ LightRed ║║ 13 │ LightMagenta ║║ 14 │ Yellow     ║║ 15 │ White     ║
  265.    ╠════╧══════════╝╚════╧══════════════╝╚════╧════════════╝╚════╧═══════════╣
  266.    ╙─────────────────────────────────────────────────────────────────────────╜
  267.  
  268.    Filename Settings - Each has either a ASC, ANS or AVT preceding them. The
  269.                        ASC is used for the ASCII bulletin filename, while the
  270.                        ANS is the ANSi bulletin's filename and the AVT is the
  271.                        AVATAR bulletin's filename. The specific bulletin
  272.                        can be disabled if you specify No or Off or False as
  273.                        the filename.
  274.  
  275.    A??_Callers          Top Callers bulletin
  276.    A??_Download_File    Top Downloaders (in Files) bulletin
  277.    A??_Download_KB      Top Downloaders (in KB) bulletin
  278.    A??_LongAgo          How long Ago (Did they call) bulletin
  279.    A??_Message          Top Message Writers bulletin
  280.    A??_TimesCalled      Number of times Called bulletin
  281.    A??_UpLoad_File      Top Uploaders (in Files) bulletin
  282.    A??_UpLoad_KB        Top Uploaders (in KB) bulletin
  283.    A??_UserAges         User Age Statistics bulletin
  284.    A??_SecLevels        Security Levels Statistics bulletin
  285.    A??_MaleFemale       Male / Female Statistics bulletin
  286.    A??_Settings         The User Settings Report
  287.    A??_Birthdays        The Upcoming Birthdays bulletin
  288.    A??_MsgBase          The Most Active Message Areas bulletin
  289.    A??_FileReport       The File Ratio Report bulletin
  290.  
  291.  
  292. ┌─
  293. │  3.3  The TOPSTAT.EXC file
  294. └──────────────────────────────────────────────────────────────────────────────
  295.  
  296.    TopStat is able to use an external file of users to exclude. It will use
  297.    this list to filter out the users listed from ALL of the bulletins. The
  298.    name file must be named TOPSTAT.EXC and must be located in the TopStat
  299.    system directory (The directory you run TopStat from.)
  300.  
  301.    Currently TopStat will only use the first 25 users in the exclude list.
  302.  
  303.    The file _MUST_ contain only one user per line. The name must have the
  304.    spaces between first name and surname must be replaced with an underscore
  305.    (_). TopStat isn't case-sensitive.
  306.  
  307.    A sample Exclude file may look like this:
  308.    ----------------------------
  309.    Dwayne_Heaton
  310.    Joaquim_Homrighausen
  311.    Andrew_Milner
  312.    Mats_Birch
  313.    Mats_Wallin
  314.    ----------------------------
  315.  
  316.  
  317. ┌─
  318. │  3.4  The TOPSTAT.SEC file
  319. └──────────────────────────────────────────────────────────────────────────────
  320.  
  321.    TopStat is able to use an external which describes your security levels,
  322.    which if it exists will be used to build up the Security Levels bulletin.
  323.    The name file must be named TOPSTAT.SEC and must be located in the TopStat
  324.    system directory (The directory you run TopStat from.)
  325.  
  326.    Currently TopStat will only use the first 25 levels in the list.
  327.  
  328.    The format of each line in the file is as follows.
  329.  
  330.       Level, Description, Time Limit and Download Limit
  331.  
  332.    The file _MUST_ included all the information for a security level on one
  333.    line. The description must have any spaces replaced by an underscore (_)
  334.    There needs to be a minimum of one space between each field (level,
  335.    description, time limit and download limit).
  336.  
  337.    A sample Exclude file may look like this:
  338.    -----------------------------------------
  339. ;
  340. ; Level    Description           Time Limit    Download Limit
  341. ;
  342.       0    Locked_Out_User             0              0
  343.       8    Un-Registered_User         30            500
  344.      16    Registered_User            60           1250
  345.      32    Enhanced_User              75           2000
  346.      64    Super_User                 90           2750
  347.     128    Vising_Sysop              120           5000
  348.  
  349.  
  350.    Any security levels that you don't include in the TOPSTAT.SEC file will
  351.    be displayed on the bulletin as 'Unlisted Security Levels' with a count
  352.    and a percentage.
  353.  
  354.  
  355. ┌─
  356. │  4.0  Bug Reports and Contacting the Author
  357. └──────────────────────────────────────────────────────────────────────────────
  358.  
  359.   Please contact me if you have any bug reports and/or suggestions for
  360.   improvements to TopStat.
  361.  
  362.   If you have a bug report, fill in the REPORT.BUG file that should have
  363.   been included in the distribution archive, rename the file to your boards
  364.   name (or first 8 characters :) [Please keep the extension of .BUG]
  365.   and mail it to me at one of the addresses below.
  366.  
  367.   I'm open to suggestions for support for other BBS software. If you wish
  368.   this please supply the structure of the userbase (and all related files)
  369.   files (PASCAL please!!) of the BBS software you wish supported (Also, could
  370.   you give me a list of environment variables it uses, and what they point to,
  371.   ie RA points to the RemoteAccess system directory, and the CONFIG.RA data
  372.   file). I cannot guarantee it will be supported in future versions (if any),
  373.   but you never know.
  374.  
  375.   I can be contacted using a number of different methods:
  376.  
  377.   Page/Leave a message on my BBS:
  378.    Virtual Maddness -- +44-1344-422575 -- 24 hours, 300 to 33,600 baud
  379.  
  380.   Send a netmail to me at one of my various AKAs:
  381.    FidoNet    :  2:252/314
  382.    RANet      :  73:7441/13
  383.    PascalNet  :  115:4401/407
  384.    Internet   :  dwayne@vmadd.demon.co.uk
  385.                  dwayne@roan.co.uk
  386.  
  387.  
  388. ┌─
  389. │  5.0  The TOPSTAT.CTL file
  390. └──────────────────────────────────────────────────────────────────────────────
  391.  
  392.    Thanks to my beta testers for helping me test my progs and for their
  393.    numerous suggestions, helpful criticism and for the multitude of bug
  394.    reports.
  395.  
  396.    Thanks to Peter Burnett for supplying various bits of source code.
  397.  
  398.    Also thanks must go out to all the people who have sent suggestions to me
  399.    (Please keep it up), no names since you know who you are (actually the list
  400.    is too large to be included here)
  401.  
  402.  
  403.  Beta Testers
  404.  ============
  405.  
  406.    Andrew Thomas        Andy's Bulletin Board!    +44-161-343-4730
  407.                         FidoNet    2:250/176
  408.                         RANet     73:7446/15
  409.  
  410.    Dean Rocks           The Happy Hippy BBs       +44-1325-354105
  411.                         FidoNet    2:256/602
  412.                         RANet     73:7447/602
  413.  
  414.    Steven Holme         The Fonty Towers BBS      +44-115-952-7443
  415.                         FidoNet    2:2503/216     +44-115-955-4440
  416.                                    2:2503/226
  417.                         RANet     73:7444/22
  418.  
  419.    Peter Burnett        Neverland eXpress         +44-1424-853361
  420.                         FidoNet    2:441/80
  421.                         RANet     73:7441/206
  422.  
  423.    Michael Devonport    Midnite Madness BBS       +44-181-287-5901
  424.                         FidoNet    2:254/301
  425.                         RANet     73:7441/15
  426.  
  427.    Simon Cansick        Guru-Ten BBS              +44-1535-691734
  428.                         FidoNet    2:250/364      +44-1535-691735
  429.                                    2:250/365
  430.                         RANet     73:7448/13
  431.  
  432.  
  433. ┌─
  434. │ End of File TOPSTAT.DOC
  435. └──────────────────────────────────────────────────────────────────────────────
  436.  
  437.